// Copyright 2006 - 2008: Rory Plaire (codekaizen@gmail.com)
//
// This file is part of SharpMap.
// SharpMap is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// SharpMap is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public License
// along with SharpMap; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

using System;
using GeoAPI.Indexing;

namespace SharpMap.Indexing.RTree
{
    public class DynamicRTreeBalanceHeuristic : IndexBalanceHeuristic
    {
        /// <summary>
        /// Creates a new DynamicRTreeBalanceHeuristic with optimum heuristic values.
        /// </summary>
        /// <remarks>
        /// Where did I find these so called "optimum" values? I wrote them down without the
        /// reference.... d'oh!
        /// TODO: find the reference for RTree insert heuristics.
        /// </remarks>
        public DynamicRTreeBalanceHeuristic()
            : base(4, 10, UInt16.MaxValue) { }

        public DynamicRTreeBalanceHeuristic(Int32 nodeItemMinimumCount, Int32 nodeItemMaximumCount, UInt32 maxTreeDepth)
            : base(nodeItemMinimumCount, nodeItemMaximumCount, maxTreeDepth) { }

        public override Int32 TargetNodeCount
        {
            get { return NodeItemMaximumCount - NodeItemMinimumCount + 1; }
        }
    }
}
